home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / rem_acc / tuhm.zip / TUHM.DOC < prev    next >
Text File  |  1996-04-25  |  5KB  |  111 lines
  1.               The Ultimate Hypertext Manager (TUHM)
  2.               ________________________________
  3.  
  4. 1. Functionality :
  5.   This program introduces the notion of (elementary) hypertext to BBSs running
  6.   Remote Access (RA).   Sysops can write their own text-files (e.g. online
  7.   help for their users) and link them together.  With the registered version 
  8.   of this program, sysops also have the possibility to let their users start 
  9.   selected programs from within these text-files.
  10.  
  11. 2. Syntax rules :
  12.   A link to another document (file) is inserted as follows :
  13.  
  14.               <href=filename><text to appear on screen>
  15.  
  16.   where 'filename' stands for the name of the file that must be opened when 
  17.   the user selects this item, and 'text to appear on screen' is what the user 
  18.   will see.
  19.  
  20.   To give the user a selection that will launch another program looks as 
  21.   follows :
  22.  
  23.               <shell=commandline><text to appear on screen>
  24.  
  25.   with the same conventions as before.  The extension (.EXE, .COM or .BAT) 
  26.   _must_ be specified.  'commandline' can contain _some_ of the parameter
  27.   specifications that RA allows (namely *b, *n, *p, *t and *o).  These will
  28.   be expanded the same way as they are by RA.
  29.  
  30.   Note that a href/shell must be specified on one single line (i.e. you
  31.   cannot split the definition across lines).
  32.  
  33.   Registered users can add color to their text by inserting ^1, ^2, ^3 or ^4 
  34.   just before where they want the color to change (actually, even 
  35.   unregistered users can do this, but the effect will be nil).  When no color 
  36.   is specified, the default color 1 is taken.  The colors can be specified 
  37.   with the TUHMCFG program (again : this can be done by everyone, but only 
  38.   registered users will notice a difference when running TUHM).
  39. 3. Example :
  40.   The following text gives the user a simple menu from which he can choose 
  41.   several possibilities:
  42.  
  43.   1. Get some help about <href=c:\ra\tuhm\tuhm.hlp><using TUHM>
  44.   2. Launch <shell=c:\games\addictive.exe><an addictive game>
  45.   3. Get some ^2help^1 about <href=c:\ra\mybbs.txt><finding your way around this BBS>
  46.  
  47.   The first and third lines will open the specified files for the user (when 
  48.   he selects them), while the second one will start a program for him.
  49.  
  50.   The word 'help' on the third line will be colored differently (color 2 will 
  51.   be used, a color specified by the sysop).
  52.  
  53.   Finally : the files 'Example.txt' and 'Example2.txt' are an example of two
  54.             files that are linked.
  55. 4. Installing the program :
  56.   You can place the program in any directory you want, the only thing that 
  57.   you must do to give users access to the program is installing it as a 
  58.   door-program in RA.  The command-line you specify should look like this :
  59.  
  60.                     C:\TUHM\TUHM.EXE *! filename
  61.  
  62.   supposing that you had installed it in a directory called TUHM.  'filename' 
  63.   is the name of the file that you want your users to see when starting the 
  64.   program.  It could be for instance a file containing the example lines 
  65.   above.  The '*!' freezes the RA-timer (this is necessary because TUHM 
  66.   does its own time management).
  67.  
  68.  
  69.   Registered users receive a key file (TUHM.KEY).  This file _must_ be 
  70.   placed in the RA root directory (the one to which the RA environment 
  71.   variable points).
  72.  
  73. 5. Keypad :
  74.   The following keys are available to the users :
  75.  
  76.     * Tab, Arrow Up, 8          => next link/shell in same file
  77.     * Shift Tab, Arrow Down, 2  => previous link/shell in same file
  78.     * Enter, Right arrow, 6     => follow link
  79.     * Esc, Left Arrow, 4        => return one level
  80.     * Page Down, 3              => next page
  81.     * Page Up, 9                => previous page
  82. 6. Registration :
  83.   And now for the big surprise ... Registration only costs 100 BF (fl 6, 
  84.   5 US$, 3 GBP), except for the French who will have to pay 100 FF (eat your
  85.   heart out Chirac).
  86.  
  87.   This money should, one way or another, come in the hands of the author :
  88.  
  89.             Frank Van Camp
  90.             Beekvelden 25
  91.             2840 Reet
  92.             Belgium
  93.  
  94.             Bank account : 979-3710633-97 (Argenta bank in Belgium)
  95.  
  96.             e-mail : vancamp@rma.ac.be
  97.                      frankvc@glo.be
  98.             Fido   : 2:292/8013.2
  99.  
  100.   In order to make the key-file, I need the following information:
  101.             sysop name
  102.             BBS name
  103.             Fido-address
  104.   and ... this information must be _exactly_ as it appears in your 
  105.   RA-settings (i.e. case sensitive, including all comma's and periods, ...).
  106.  
  107.   The key will be sent to you through netmail (or e-mail).  Just copy that
  108.   file to your RA directory and your program becomes a registered one and 
  109.   all the features become available.
  110.  
  111.